/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.client;

import java.util.Properties;

import cgl.narada.event.TemplateInfo;
import cgl.narada.matching.Profile;
import cgl.narada.service.ServiceException;
import cgl.narada.service.qos.impl.QosServiceImpl;
import cgl.narada.service.replay.ReplayRequest;


/** This class provides a set of core functions that are utilized by 
    applications 

    @author Shrideep Pallickara
    $Date$
    $Revision$
*/ 

public interface ClientService  {
  
  public int getEntityId();
  
  public void initializeBrokerCommunications(Properties props, 
					     String commType) 
    throws ServiceException;
  

  // HG:
  public void setCommunicationLossListener(
           ConnectionLossListener connLossListener);

  // ----

  public boolean isInitialized();

  /** Creates a profile */
  public Profile createProfile(int type, Object subscription)
    throws ServiceException;

  /** Creates a profile */
  public Profile createProfile(int type, String profileId, Object subscription)
  throws ServiceException;
  
  public QosServiceImpl getQosServiceImpl();
  
  /** Creates a template info */
  public TemplateInfo createTemplateInfo(int templateId, int templateType,
					 Object template) 
    throws ServiceException;
  
  /** Creates a template info */
  public TemplateInfo createTemplateInfo(int templateId, int templateType,
					 Object template,
					 Object allEncompassingConstraint)
    throws ServiceException;
  
  public EventConsumer createEventConsumer(NBEventListener listener)
    throws ServiceException;
  
  public EventConsumer 
  createEventConsumer(NBEventListener listener, 
		      NBNotificationListener notificationListener)
    throws ServiceException;
  
  /** Create an event producer */
  public EventProducer createEventProducer() throws ServiceException;
  
  /** Create an event producer with the specified NotificationListener */
  public EventProducer 
  createEventProducer(NBNotificationListener notificationListener)
    throws ServiceException;

  /** Create a repleay request based on the sequences that need to be
      replayed */
  public ReplayRequest 
  createReplayRequest(int templateId, long[] sequencesToReplay) 
    throws ServiceException;

  /** Create a replay request based on the specified range */
  public ReplayRequest 
  createReplayRequest(int templateId, long sequenceStart, long sequenceEnd)
    throws ServiceException;
  
  /** Create a replay request based on the specified constraints */
  public ReplayRequest 
  createReplayRequest(int templateId, long sequenceStart, long sequenceEnd, 
		      Profile[] specifiedConstraints)
    throws ServiceException;


  /** Signoff. All communications resources including the connection to the
      broker are released */
  public void closeBrokerConnection() throws ServiceException;
  
  public boolean hasPendingTransfers() throws ServiceException;

  /** Terminate services that are currently running within the JVM */
  public void terminateServices() throws ServiceException;

}
